home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 051-075 / scopedisk70 / nag08 / nag.doc < prev    next >
Text File  |  1995-03-19  |  23KB  |  434 lines
  1. *********************************************************************
  2. *************************    Nag 1.1 doc   **************************
  3. *********************************************************************
  4.  
  5.      `Nag' is an electronic appointment calendar for the Amiga. In
  6. addition to keeping track of your appointments, your anniversary, and
  7. your mother-in-law's birthday, `Nag' can be instructed to gently
  8. remind you by popping up a display of the next `nagged event', and
  9. hanging around flashing or beeping or playing a digital sample and/or
  10. using the Amiga's voice to 'NAG' (remind) you every 30 seconds until
  11. you respond.
  12. You can also TURN THE NAG OFF! (Much better than your mother-in-law!)
  13.  
  14.     REQUIREMENTS:  Amiga 500, 1000, or 2000.
  15.                     Set to 80 column mode.
  16.                      Default font or custom 8x8 font. (I use Pearl).
  17.             NOTE:  If you use Nag's VOICE feature, the following
  18.                     standard WORKBENCH files must be accessible.
  19.                    devs:narrator.device   libs:translator.library
  20.                    
  21.       DISCLAIMER:  I disclaim responsibility for anything whatsoever
  22.                     that might occur as a result of using this program.
  23.                      As a matter of fact, I disclaim any responsibility
  24.                       for the content of this disclaimer. So there.
  25.  
  26.        GUARANTEE:  I guarantee that Nag works well for me, and I will
  27.                     continue to update and revise as I deem necessary
  28.                      to try to make it work PERFECTLY for everyone. 
  29.  
  30. *********************************************************************
  31. **********************  Getting Nag Set-Up  *************************
  32. *********************************************************************
  33.  
  34.      Nag is intended to be run in the background and started from
  35. your startup-sequence following your time-setting procedure. In addition
  36. to the program file, and 2 (or more) "datefiles", Nag now wants a
  37. configuration file (s:Nag.config). This config file MUST be in your s:
  38. directory! You can edit it with Ed or any editor/word-processor, but
  39. be sure to maintain the format given! The first two lines are the
  40. announcement the voice makes before giving the 'nag' information. The
  41. rest of the config file is notated. Be sure that the nagDir path points
  42. to your Nag.198? files. One datefile is required for this year and one
  43. for next year. I keep Nag and it's year files (Nag.1988, etc) in the
  44. system directory of my WORKBENCH disk. If 'sPath' is not blank in the
  45. s:Nag.config file, Nag will load the the digital sound sample into CHIP
  46. memory at startup and/or when re-configuring. (If you are short on RAM,
  47. or need a lot of CHIP RAM, use a short sample or no sample at all!)
  48.  
  49.      Feel free to re-configure the config file, that's what it's for!
  50. The changes will take place the next time you run Nag, or you may force
  51. the changes immediately by selecting the title box from the main menu
  52. (the lower right corner). A requestor will pop up offering a choice
  53. of re-configuration or no-change. If you choose unreasonable values for
  54. any number in the config file, Nag will substitute 'middle-of-the-road'
  55. values. Nag looks for a space to tell where any Path string ends, so
  56. don't put any embedded spaces within the the nagDir Path or in the
  57. soundFile path! Sample config files are included with the .arc file.
  58.  
  59.      Sample year-files are included with this .arc file. They contain
  60. standard holidays and other "important" dates. ;-)  Also included are
  61. a couple of config files, to show by example how they work.
  62.  
  63.      Try entering all your birthdays, anniversaries, holidays, and
  64. other dates that don't change year to year into the generic 'Nag.year'
  65. file. Then, when you need a new year, just copy Nag.year to Nag.1989.
  66.      Using the COPY & RECALL functions makes entering repeated dates,
  67. (like WAG meetings, Car maintenence, "Washday"), etc. quick and painless.
  68.  
  69.      To use these files, 1st, install s:Nag.config in your 's' directory,
  70. then install Nag.1988 and Nag.1989 in your chosen directory. (see above).
  71. (I use the system directory on my df0: ). Then install Nag in your chosen
  72. directory. (I again use sys:system ). Then edit your s:startup-sequence
  73. thus: (this assumes you use what I use).
  74.  
  75.      - - - -                       (various stuff here)
  76.      RTClock    (This sets MY system time. The idea is, just make sure
  77.      - - - -                      the time is set before you run Nag).
  78.      LoadWb       (if you use WorkBench, it must be loaded before Nag)
  79.      RunBack df0:system/Nag
  80.      - - - -                    (might be more stuff here)
  81.      EndCLI > nil:
  82.  
  83. NOTE: If you don't have runback, or have problems making Nag work,
  84.       try this:
  85.         1> Use 'Ed' to make a textfile called   s:Nag.x   which
  86.            contains only one line,    'Run Nag'.
  87.         2> Add the following line in place of the 'RunBack df...'
  88.            line in the sample startup-sequence above.
  89.            
  90.              NewCli "CON:127/11/100/10/" FROM "s:Nag.x"
  91.              
  92.  OR:  Even easier, Nag can be run by clicking on it's icon!
  93.  
  94.  
  95. *********************************************************************
  96. **********************  Getting Nag Started  ************************
  97. *********************************************************************
  98.  
  99. TO START:  Use the mouse to get to the drawer where Nag resides, and
  100.             select the Nag icon. (My humble apologies ladies! ;-)
  101.  
  102. OR:        RunBack <path>Nag   (from your startup-sequence)
  103.  
  104. OR:        Run Nag           (from a CLI you are leaving open)
  105.  
  106.     You may start Nag from any CLI, using "Run Nag", but you will
  107. be unable to close this CLI while Nag is running.
  108.  
  109. Default buffer size = 20000 bytes.   (Big enough for the casual user.)
  110.    The buffer needs to be big enough to hold both this year and next
  111. year's files plus what you plan to add when editing. The structure of
  112. the nag entries has been made as memory efficient as possible, so the
  113. default buffer will hold more than 400 entries.
  114.  
  115.   (Minimum size = 6,000 bytes, Maximum size = 4,000,000 bytes. If you
  116.    try to use an out of range buffer size, Nag will choose the closest
  117.     valid value. SET THE BUFFER SIZE IN THE s:Nag.config FILE!)
  118.  
  119. To figure out how large a buffer you require, add the filesizes of the
  120. Nag.year files, (Nag.thisyear + Nag.nextyear), plus an additional 1000
  121. or so as Editing space. (a single event will take, AT MOST, 60 bytes
  122. in the Nag.year file.)
  123.  
  124. NOTE:  Nag WILL run without config OR year files, but will complain
  125.        bitterly every time you start 'er up. 
  126.  
  127.  
  128. *********************************************************************
  129. **********************  Tiny "Sleeping" Window  **********************
  130. *********************************************************************
  131.  
  132.      When first run, the word 'Nag' in contrasting colors will appear
  133. in the workbench display. This is the "sleeping" window. This is Nag
  134. at rest. You may set in the s:Nag.config file exactly where on the
  135. screen you want this little window to stay. If the BACKDROP flag is
  136. set in s:Nag.config, it is possible to slide it up under the WORKBENCH
  137. title. If, for instance, you set the TopEdge of the Tiny Window to 2,
  138. (tPlace in s:Nag.config),, the only visible sign of Nag is a 30 pixel
  139. horizontal line in WORKBENCH color number 3 just under the title line.
  140. This Tiny Window, where ever you put it, will STAY behind all windows.
  141. In fact, in some ways, it is more like a disk icon than a window...
  142.   (This is in answer to a request, OK Tom?)
  143.      If the BACKDROP flag in s:Nag.config is set to 0, the nag window
  144. will be a normal, albeit small, window. (In this mode the Nag window
  145. will START in front and stay at whatever level you leave it.)
  146.  
  147.       Nag will now hang around waiting for one of two events.
  148.  
  149.    1. The Timer signal arrives. (Time to remind you!)
  150.         In this case, the "Nag Window" will pop up displaying the event
  151.          which triggered it. (As long as the "Nag" button is "lit", the
  152.           "Nag Window" will pop-up in front of all current screens.)
  153.             NOTE: If you are editing or searching when the Timer signal
  154.                   arrives, that window will be closed before the Nag
  155.                   message arrives.
  156.         
  157.            YOU MUST PRESS THE LEFT MOUSEBUTTON INSIDE THE NAG
  158.            WINDOW TO ACKNOWLEDGE THE NAG AND MAKE IT GO AWAY!
  159.        
  160.         An un-acknowledged nag will repeat every 30 seconds
  161.         until it is acknowledged...   (soooo irritating... ;-)
  162.  
  163. or 2. A left mouse-button press somewhere in the word "Nag".
  164.         In this case, you are taken to the main display screen and the
  165. current list of upcoming appointments is listed.
  166.  
  167. NOTE: If there are UPCOMING EVENTS whose reminders have been missed
  168.        because Nag has just now started, Nag will open the MAIN DISPLAY
  169.         WINDOW when first run, and display what you missed. (Your
  170.          startup-sequence will continue in the background.)
  171. NOTE: You may also initiate this "Missing Nags Search", from any date,
  172.       by 'SEARCH'ing for a single character.
  173.         
  174. *********************************************************************
  175. ***********************  MAIN DISPLAY WINDOW  ***********************
  176. *********************************************************************
  177.  
  178.      The title line displays Today's date and the APPROXIMATE number of
  179. minutes until the next "nagged" event. (This line is updated each time
  180. you select "NOW")
  181.      The current list of appointments is displayed in the large area
  182. on the left side of the main display window, each day "headered" with
  183. a date-line. If the appointment or event is within one week of NOW,
  184. the Day-Of-The-Week will be highlighted. 'Today' and/or 'Tommorrow',
  185. as they relate to NOW, will also be indicated.
  186.      A 'dot' located between the time and the event indicates that 1 or
  187. more Nag Flags have been set. Black(color #2) = Flash, Red(color #3) =
  188. SOUND nag and White(color #1) = VOICE nag. To determine EXACTLY which
  189. flags and how many nags are set, use the Edit Screen. (see below)
  190.  
  191.                   -*-  Calendar  Display  -*-
  192.      Dates are intially in black (color #2), then those dates which
  193. have an event are changed to red (color #3), or if there is a 'nagged'
  194. event, that date is changed to white (color #1). You can tell with
  195. a glance at the calendar when your next 'open' day will be.
  196.      You may also REVERSE color #1 and color#3 by setting a flag
  197.      in the s:Nag.config file. (see below)
  198.  
  199.    CREDIT:  Some calendar routines were borrowed from a public domain
  200.              program called "calendar". I hereby thank the author of
  201.              calendar, for saving me a lot of "grunt work"!
  202.              
  203. Calendar gadgets: The year and/or month can be changed by pressing the
  204.                   left mouse button on the "<<<  >>>" marks.
  205.                       (Nag will not update the appointment display
  206.                           until a day of the month is chosen)
  207.                   The current day of the month can be changed by
  208.                   pressing the left mouse button on the selected day.
  209.  
  210.              NOW: Resets Nag to current time and date.
  211.  
  212.     1 NAG or NAG: This is now 2 "flag"s. If one is on (lit), the `nag'
  213.                   feature is activated. Off means "Nag is gagged".
  214.                   Selected again will show "1 Nag". This is a single
  215.                   shot feature. When this flag is lit, only one nag
  216.                   will appear for each nagged event. You DO NOT have
  217.                   to respond to the nag when this flag is lit. It
  218.                   will show for 15-20 seconds and go away ATTEMPTING
  219.                   to return your machine to the way it was before
  220.                   the nag began.
  221.                   
  222.             EDIT: Takes you to the "Edit" Screen. (see below)
  223.  
  224.            PRINT: Uses preferences thru PRT: device to print hardcopy
  225.                    of selected appointments. (skips perferation).
  226.                   Prodedure: Select start date, select PRINT, (gadget
  227.                    lights to indicate that PRINT is active), select
  228.                     end date, select PRINT again. When the display
  229.                      returns to show the start date, control has
  230.                       been returned to you.
  231.                  To print currently selected day, just double-click
  232.                   the PRINT gadget. (selecting a day starts the day
  233.                    from 12:01am, selecting NOW makes PRINT start
  234.                     from the current hour.
  235.   
  236. NOTE: IF YOU NEED TO ABORT THE PRINTING:
  237.       Turn off your printer, wait 30 seconds or so for the 'printer
  238.       trouble' requestor to appear, and select 'CANCEL'.
  239.       
  240. IF THAT DOESN'T WORK OR YOU ARE IMPATIENT:
  241.      Keep turning your printer on and off until control returns.
  242.        (Yes, I'd call this a bug, but NOT MINE.)
  243.  
  244.           SEARCH: Makes a non case-dependent search of the "message"
  245.                    parts of the entries for the entered string and
  246.                     displays each occurance on the main screen.
  247.                   A string of only one character will display all
  248.                    'missed' nags from the currently selected date.
  249.                   
  250.           SHRINK: Returns Nag to the "sleeping" mode.
  251.                   (This is the proper way to exit Nag. It remains
  252.                    ready, but in the background waiting. In addition,
  253.                     any changes in the year files are automatically
  254.                      saved in case the system goes down prematurely.)
  255.                    
  256.             QUIT: Removes Nag from the operating system. Changes in
  257.                    the year files are saved before Nag gives up if
  258.                     you select 'Yes' when the Requestor pops up.
  259.  
  260.            TITLE: The title box (lower right corner) is also a gadget.
  261.                     It re-loads the config file and reconfigures ALL
  262.                      of Nag if you select the 'Yes' Requestor.
  263.  
  264.  
  265. *********************************************************************
  266. *************************   EDIT SCREEN  ****************************
  267. *********************************************************************
  268.  
  269.      NOTE: Nag only works on, and edits, THIS year and NEXT year.
  270.             If you leave your Amiga running thru New Year's Eve,
  271.              Please 'QUIT' Nag and re-start to set the new year.
  272.               (If you don't, Nag will continue to use the original
  273.                yearfiles, and you will be unable to edit next year.)
  274.  
  275.      You are editing ONE day. The day that was set on the `calendar'.
  276. All of the "/\" and "\/" thingies are gadgets. Starting from the upper
  277. left, the first set controls the hours, the 2nd set controls the 
  278. minutes, and the 3rd set controls the line number. You may have up to
  279. 99 lines per day. The hour control gadgets can be used to set certain
  280. visual flags (BIRTHDAY, ANNIVERSARY, !ACTION!) instead of a specific
  281. time. Also, am/pm can be switched by selecting the am/pm gadget.
  282.  
  283.     DELETE removes the currently displayed line.
  284.     COPY   copies  the currently displayed line into the Copy buffer.
  285.     RECALL copies  the Copy buffer into the currently displayed line.
  286.    (The last event copied remains safe in the Copy buffer until QUIT.)
  287.  
  288.      At the upper right is the Nag Flag selection area. You may select
  289. any combination of time periods to be "nagged". (1/4 Hour, Hour, Day,
  290. Week, Month and/or OnTime) previous to the "event", and up to 7 "nags"
  291. per time flag. For example: if you have selected 1/4 Hourly, Hourly,
  292. and Daily, the number of nags is 2, and the "Nag" flag is "lit" on the 
  293. Main Display Screen, you will be reminded of the upcoming event at 48 
  294. hours, 24 hours, 2 hours, 1 hour, 30 minutes, and 15 minutes before the
  295. upcoming "event". Nag won't nag you at the exact time of the event
  296. unless you have set the "On Time" nag flag.
  297.  
  298.      The fourth set of "/\ \/" gadgets controls the "Nags Per Flag".
  299. When a nagFlag is selected, Nags Per Flag will automatically advance
  300. to 1. When all Flags are de-selected, nags will automatically go to 0.
  301.    Note that if no flags are selected, Nags Per Flag can NOT be set.
  302.  
  303.      Above the Nag Flag Selection area are two more selection gadgets
  304. for 'VOICE' and 'SOUND'. You may select either, both or none for each
  305. event. None = flash (Amiga function DisplayBeep). If you want no nags
  306. at all, leave ALL flags OFF for this event, or turn off the NAG gadget
  307. on the Main Display Window. (The latter disables ALL nags)
  308.  
  309. NOTE: Settings for the VOICE and SOUND are in the Nag.config file.
  310.        Any file may be used as the SOUND file, but real digital samples
  311.         seem to work best. ;-)  If the file is in IFF format, the proper
  312.          Period will be computed, otherwise, the value in s:Nag.config
  313.           is used. If Nag cannot find your digital-sample-sound-file,
  314.            (sPath in s:Nag.config), it will use an internal 16 byte
  315.             triangle wave as sound data with the s:Nag.config values.
  316.  
  317.          DONE: Means you are satisfied with editing this day's
  318.                 appointments. (Changes will be saved automatically
  319.                  if you 'SHRINK', or Requestored if you 'QUIT'.)
  320.  
  321.        CANCEL: Means you want Nag to `forget' this editing session.
  322.                 (no changes saved, everything the way it was before
  323.                  you started to edit.)
  324.  
  325.     SHAREWARE: The shareware message is also a gadget. It generates
  326.                 a TEST 'nag' using the event and settings you are
  327.                  currently editing.
  328.  
  329. To Enter New Appointments:
  330.  
  331.      Make sure you are looking at the "Editing:" screen.
  332.      Use the Line # gadgets to move to a blank line. (highest #)
  333.      Type in the information to be displayed. (up to 45 characters)
  334.         Press RETURN to enter a new "message" string.
  335.      Then: If you want to be nagged, light at least one 'Nag Flag'.
  336.      (If you select VOICE and/or SOUND first, Nag assumes you want
  337.        an 'OnTime' nag and sets that flag for you.)
  338.  
  339. NOTE: You MUST enter a message string before you can set anything.
  340. NOTE: You MUST set at least one flag before it is possible
  341.        to set the number of nags. (That makes sense, doesn't it?)
  342. NOTE: To 'unset' nags, turn ALL flags OFF.
  343.        
  344. Finally:  Select the 'DONE' gadget to 'save' the changes to the main
  345. buffers. (The buffers are saved to disk when you SHRINK or QUIT Nag.)
  346.  
  347.       You may test your new nag by selecting the Shareware Notice.
  348.  
  349.                       That's all there is to it!
  350. You can watch your work updating the day's entries in the window below.
  351. When the day looks correct, REMEMBER to select "DONE" to save that day.
  352.  
  353. *********************************************************************
  354. ********************  Nag.config,  line by line  ********************
  355. *********************************************************************
  356.  
  357.    This file (s:Nag.config), can be edited with most editors or word
  358.     processors. The 'Ed' that comes with your WorkBench works fine.
  359.      MAINTAIN THE FORMAT! (same # of lines, data starts on space 11,
  360.       spaces on either side of data, etc.), or Nag will get confused!
  361.  
  362. Line  1: The first thing the voice will say.
  363.       2: The second thing the voice will say.
  364.       3: Size of the buffer in bytes.
  365.       4: Full path to the Nag.1988, Nag.1989, etc. files
  366.       5: Default hour. Birthdays and other days with no specific hour
  367.           entered will be nagged at this hour. (military time!)
  368.       6: NagFlag. 1=ON, 0=OFF.  If OFF, no nags will occur at all.
  369.       7: SingleShot Flag. 1=ON, 0=OFF. If ON, nags will not repeat
  370.           every 30 seconds.
  371.       8: VOICE: Words Per Minute.
  372.       9: VOICE: Pitch of voice.
  373.      10: VOICE: Sex and Mode of Voice. 0or2=Male,1or3=Female,>1=Robot
  374.      11: VOICE: Frequency at which the voice was sampled.
  375.      12: SOUND: Period. Time to play one sample length. (127-65535)
  376.      13: SOUND: Volume. 0=MIN, 64=MAX.
  377.      14: SOUND: Cycles. Number of sound sample repeats.   (1-65535)
  378.      15: Left Edge of the Tiny Window.  (0-608)
  379.      16: Top  Edge of the Tiny Window.  (0-189) (interlace 0-389)
  380.      17: bdFlag toggles Tiny Window.  Normal = 0,  BACKDROP = 1.
  381.      18: ColorFlag. 0 = Normal, 1 = Colors 1 & 3 are reversed.
  382.           (This may be of help if you use 'strange' WorkBench colors.)
  383.      19: sPath: Full path and filename for digital sound sample.
  384.           If the sample is IFF, the Period will be calculated and the
  385.            config file sPeriod will be ignored. If the config file has
  386.             the Cycles set to more than 10, Cycles will default to 1
  387.              to play the digital sample. Volume is ALWAYS read from
  388.               the s:Nag.config file. Re-config reloads soundfile.
  389.  
  390. NOTE: Be sure to maintain the order and format of the configuration
  391.        file or you will be in deep guano! Keep the vertical lines
  392.         vertical, and the data starting on the 11th character.
  393.  
  394. *********************************************************************
  395. ***************************   SHAREWARE   ***************************
  396. *********************************************************************
  397.  
  398.   The Concept:  Quality software you get to try in your own computer
  399.                 environment at little or no cost.
  400.                 
  401.     The Pitch:  If you find that you continue to use this software,
  402.                 a $10 donation to the author is encouraged and will
  403.                 place your name on the official "user's list".
  404.                 $15 or more will also get you a disk with the latest
  405.                 versions of Nag and other shareware.
  406.  
  407.  The Address:   Richard Lee Stockton (Nag)
  408.                 21305 60th West
  409.                 Mountlake Terrace, WA 98043
  410.                 
  411.  Bug Reports:   Send to the above address (US Snail) OR:
  412.                 EMail: RLStockton  on  GENIE & PLINK OR:
  413.                 call (voice only!) (206) 776-1253 - (Seattle area)
  414.  
  415.  Distribution:  May not distributed for profit without prior written
  416.                 permission from me. Individuals ARE encouraged to
  417.                 copy and give away Nag??.arc to their friends (and
  418.                 enemies) and in addition; Fred Fish, Amicus and/or
  419.                 other public distribution services of like intent are
  420.                 hereby given permission to distribute Nag as long as
  421.                 the contents of the arc file and all copyright
  422.                 notices remain intact.
  423.  
  424.   The Promise:  I shall maintain (and update as necessary) this
  425.                 shareware product in an effort to make it the BEST
  426.                 software of it's type, commercial or otherwise.
  427.  
  428. ********************************************************************* 
  429. **************   La lingua de Amiga? Si! Poco a poco!   *************
  430. *********************************************************************
  431. ****  DON'T  PAY  BIG  BUCKS!   ***   SUPPORT  AMIGA  SHAREWARE! ****
  432. *********************************************************************
  433.  
  434.